---
sidebar_position: 1
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Rig Configuration

The Rig server is configured from the `server-config.yaml` file.
Configuration can be overridden using environment variables on the form
`RIG_<CONFIG>` where `<CONFIG>` is the configuration path in uppercase with
dots replaced by underscores. Eg. to set `client`.mailjet.api_key`
through an environment variable one would set the environment variable
`RIG_CLIENT_MAILJET_PROJECT_ID`.

The following table shows available configuration options.

| Option | Description | Default |
| ------------ | ----------- | ------- |
| `auth.jwt.certificate_file` | JWT signing public key. Mutually exclusive with `auth.jwt.secret` | - |
| `auth.jwt.certificate_key_file` | JWT signing private key. Mutually exclusive with `auth.jwt.secret` | - |
| `auth.jwt.secret` | JWT signing secret. Mutually exclusive with `auth.jwt.secret` | - |
| `client.docker.host` | Host of docker daemon | - |
| `client.mailjet.api_key` | Mailjet API key | - |
| `client.mailjet.from` | Mailjet from email | - |
| `client.mailjet.secret_key` | Mailjet secret key | - |
| `client.smtp.host` | SMTP server hostname | - |
| `client.smtp.password` | SMTP server password | - |
| `client.smtp.port` | SMTP server port | - |
| `client.smtp.user` | SMTP server user | - |
| `cluster.type` | Cluster type. Can be either `docker` or `k8s` | docker |
| `email.type` | Email type specifies how to send email. Can be left empty for no email or set to one of `mailjet`, `smtp`. Requires the corresponding `client.<email.type>` to be configured | - |
| `port` | Port which the Rig server will listen on | 4747 |
| `telemetry.enabled` | Wether to enable telemetry | true |
